<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>RunParmFile</title>
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="RunParmFile";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/util/RunParmArrayEntry.html" title="class in mmj.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/util/SvcBoss.html" title="class in mmj.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/util/RunParmFile.html" target="_top">Frames</a></li>
<li><a href="RunParmFile.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">mmj.util</div>
<h2 title="Class RunParmFile" class="title">Class RunParmFile</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>mmj.util.RunParmFile</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">RunParmFile</span>
extends java.lang.Object</pre>
<div class="block">RunParmFile reads lines designed to be parsed by DelimitedTextParser and
 returns RunParmArrayEntry objects.
 <p>
 Comment lines are identified in RunParmFileArrayEntry and this class knows
 nothing whatsoever about mmj or Metamath.
 <p>
 Coincidentally (ha), the "String[] args" parameter for the constructor is the
 same as the BatchMMJ2 command line parms.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../mmj/util/RunParmFile.html#RunParmFile(mmj.util.Paths, java.lang.String)">RunParmFile</a></strong>(<a href="../../mmj/util/Paths.html" title="class in mmj.util">Paths</a>&nbsp;paths,
           java.lang.String&nbsp;runParmFileNameArgument)</code>
<div class="block">Construct using <code>Paths</code> object and runParmFileName argument.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/RunParmFile.html#close()">close</a></strong>()</code>
<div class="block">Close RunParmFile.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/RunParmFile.html#displayArgumentOptionReport(mmj.util.Paths, java.lang.String)">displayArgumentOptionReport</a></strong>(<a href="../../mmj/util/Paths.html" title="class in mmj.util">Paths</a>&nbsp;paths,
                           java.lang.String&nbsp;runParmFileNameArgument)</code>
<div class="block">Dumps the absolute path names to System.out for testing purposes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/RunParmFile.html#getAbsolutePath()">getAbsolutePath</a></strong>()</code>
<div class="block">Returns the canonical path name of the RunParmFile.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/RunParmFile.html#hasNext()">hasNext</a></strong>()</code>
<div class="block">Checks to see if another line of input is available.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../mmj/util/RunParmArrayEntry.html" title="class in mmj.util">RunParmArrayEntry</a></code></td>
<td class="colLast"><code><strong><a href="../../mmj/util/RunParmFile.html#next()">next</a></strong>()</code>
<div class="block">Returns next line of RunParmFile formatted as a fully parsed
 RunParmArrayEntry object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="RunParmFile(mmj.util.Paths, java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RunParmFile</h4>
<pre>public&nbsp;RunParmFile(<a href="../../mmj/util/Paths.html" title="class in mmj.util">Paths</a>&nbsp;paths,
           java.lang.String&nbsp;runParmFileNameArgument)
            throws java.io.IOException,
                   java.lang.IllegalArgumentException</pre>
<div class="block">Construct using <code>Paths</code> object and runParmFileName argument.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paths</code> - mmj2 Paths object.</dd><dd><code>runParmFileNameArgument</code> - file name of RunParm file.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurred</dd>
<dd><code>java.lang.IllegalArgumentException</code> - see UtilConstants.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="displayArgumentOptionReport(mmj.util.Paths, java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>displayArgumentOptionReport</h4>
<pre>public static&nbsp;void&nbsp;displayArgumentOptionReport(<a href="../../mmj/util/Paths.html" title="class in mmj.util">Paths</a>&nbsp;paths,
                               java.lang.String&nbsp;runParmFileNameArgument)
                                        throws java.io.IOException</pre>
<div class="block">Dumps the absolute path names to System.out for testing purposes.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>paths</code> - the path names</dd><dd><code>runParmFileNameArgument</code> - if an error occurred</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurred</dd></dl>
</li>
</ul>
<a name="hasNext()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public&nbsp;boolean&nbsp;hasNext()</pre>
<div class="block">Checks to see if another line of input is available.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if another line of input is available.</dd></dl>
</li>
</ul>
<a name="next()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public&nbsp;<a href="../../mmj/util/RunParmArrayEntry.html" title="class in mmj.util">RunParmArrayEntry</a>&nbsp;next()
                       throws java.io.IOException,
                              java.lang.IllegalArgumentException,
                              java.lang.IllegalStateException</pre>
<div class="block">Returns next line of RunParmFile formatted as a fully parsed
 RunParmArrayEntry object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>RunParmArrayEntry object.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if called after EOF.</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if parsing problem.</dd>
<dd><code>java.io.IOException</code> - if I/O error on RunParmFile.</dd></dl>
</li>
</ul>
<a name="close()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
           throws java.io.IOException</pre>
<div class="block">Close RunParmFile.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if IO error</dd></dl>
</li>
</ul>
<a name="getAbsolutePath()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAbsolutePath</h4>
<pre>public&nbsp;java.lang.String&nbsp;getAbsolutePath()</pre>
<div class="block">Returns the canonical path name of the RunParmFile.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>canonical path of RunParmFile or empty string if RunParmFile is
         null.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../mmj/util/RunParmArrayEntry.html" title="class in mmj.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../mmj/util/SvcBoss.html" title="class in mmj.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?mmj/util/RunParmFile.html" target="_top">Frames</a></li>
<li><a href="RunParmFile.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
